XY Chart NET 3 Control Reference
Scale Class
XY Chart NET 3 Control Reference > Classes > Scale Class

Scale Class consists of the following properties:

Property Description Data Type Default
AutoScaleRangeFactor Determines the margin to apply to the scale range when using Auto Scale mode.
Value must be greater than or equal to zero.		 Double 0.05 (5%)
CenterToDay Applicable for DateTime formatted scales.  Determines whether the chart's data points are centered to its day values. 
For Candle profiles, the open, high, low, and close values are always displayed centered to its day values.
Boolean False
DateIncludeWeekends Applicable for DateTime formatted scales.  Determines whether to show or hide weekends (that is, Saturday and Sunday) on the scale. Boolean True
DateTimeFormat Determines the format string for the DateTime format style.

Use any of the following:

  • "hh:mm:ss"
  • "hh:mm:ss.fff"
  • "h:mm:ss tt"
  • "h:mm:ss.fff tt"
  • "d MMM h:mm:ss tt"
  • "M/d/yyyy h:mm:ss tt"
  • "M/d/yyyy h:mm:ss.fff tt"
  • "M/d/yyyy"
  • "MMMM d, yyyy"

or create your own string using Microsoft's symbols d, M, and y to represent date, and h, m, and s to represent time.  For example, "M/d/yy" will display "1/27/93".

For DateTime beyond seconds, use fff to display milliseconds (ms).		 String "hh:mm:ss"
ForceZeroDisplay When the chart is at zoomed-out-all state, and the Min and Max scale range does not overlap zero, then the appropriate Min or Max value is displayed at zero if this property is set to True.

For example, if the XScale(0) Minimum value is 10, and the XScale(0)Maximum value is 100,  then the Minimum value displayed in the chart for XScale(0) is zero.  Similarily, if the XScale(0) Maximum value is -10, and the XScale(0) Minimum value is -100, then the Maximum value displayed in the chart for XScale(0) is zero.

 Boolean False
FormatStyle Determines the scale's format style - either Numeric or DateTime. Enumerated type consisting of the following options:
  • fsNumeric (= 0)
  • fsDateTime (=1)
 fsNumeric
Invert Determines whether or not the scale will be inverted on the chart. Boolean False
Label Determines the label the scale will display. String. Maximum length of string is 100 characters. "" (blank)
LabelColor Determines the color used to display the label.
LabelGradient characteristics will override this property if the LabelGradient option is set to Custom.
Color Color.Black
LabelFont Determines the font characteristics for the label. Font Arial, 8.25pt
LabelGradient Determines the gradient characteristics for the label. Gradient Class Refer to Gradient Class
NumericFormat Determines the format string for the Numeric format style.

Use any of the following:

  • "(Auto)"
  • "#,##0.0"
  • "$#,##0 USD"
  • "#,##0k"
  • "#.0#E+0"
  • "0.0%"
  • "On/Off"
  • "True/False"
  • "Yes/No"

or create your own string using Microsoft's formatting symbols.

By setting the Numeric style string to "(Auto)", the appropriate number of decimals are automatically chosen for each tick value.  The local system's formatting for digit grouping and decimals are also applied.  That is, 1,002.25 for North American and 1.002,25 for European style number formats.
String "(Auto)"
Position Determines the position of the scale with respect to the plot area. Enumerated type consisting of the following options:
  • spLeftOrBottom (=0)
  • spRightOrTop (=1)
 spLeftOrBottom
ScaleFactor Determines the scaling factor for the axis.  ScaleFactor cannot be zero. Double 1
ScaleInterval Determines the interval between two major ticks.  A value of zero enables the scale interval to be calculated automatically.  The automatic scale interval calculation determines the optimal interval with easily readable numbers. Double 0
ScaleManualMax Determines the maximum scale value in the Manual scale mode. Double 0
ScaleManualMin Determines the minimum scale value in the Manual scale mode. Double 0
ScaleMode Determines the scale mode - either Auto or Manual. Enumerated type consisting of the following options:
  • smAuto (= 0)
  • smManual (=1)
 smAuto
ScaleType Determines the scale type - either Linear or Logarithmic. Enumerated type consisting of the following options:
  • stLinear (= 0)
  • stLog (=1)
 stLinear
ScaleWidthHeight For Y scales, determines the scale's width.  For X scales, determines the scale's height.   A value of zero enables the scale width/height to be calculated automatically.  Units are in Pixels. Integer 0
SingleGridLineDisplay Determines whether or not a single grid line will be displayed for the scale. SingleGridLineValue determines the value of the grid line to display. 
In YStack plotting, the grid lines for each x-scale is duplicated across all y-stack plots.   Hence, enabling SingleGridLineDisplay will also duplicate the single grid line value across all y-stack plots.
Boolean False
SingleGridLineValue Determines the value of the single grid line to display for the scale. SingleGridLineDisplay must be set to True. Double 0
TickLabelSpacing Determines the minimum spacing between major tick labels.. Double 1
TicksColor Determines the color used to display the scale's tick values. Color Color.Black
TicksFont Determines the font characteristics for the scale's tick values. Font Arial, 8.25pt
Visible Determines whether or not the scale is visible on the chart. Boolean True

 

See Also
Properties
XAxis
YScale Class

 

 

© 2003 - 2013 ControlEng Corporation. All rights reserved.